![From Academia to Industry](https://cdn.sanity.io/images/cgdhsj6q/production/70501690bf807891573e259da9719cf24302c7e3-4288x2848.jpg?w=400&fit=max&auto=format)
Employee Spotlight
From Academia to Industry
Philipp Burckhardt recounts his journey from childhood computer fascinations, to building an e-learning platform at Carnegie Mellon University, and on to his current role at Socket.
@smithy/signature-v4
Advanced tools
A standalone implementation of the AWS Signature V4 request signing algorithm
Package description
@smithy/signature-v4 is an npm package used for signing AWS requests using the AWS Signature Version 4 signing process. This is essential for securely making authenticated requests to AWS services.
Signing HTTP Requests
This feature allows you to sign HTTP requests to AWS services using the AWS Signature Version 4 signing process. The code sample demonstrates how to sign a GET request to an S3 bucket.
const { SignatureV4 } = require('@smithy/signature-v4');
const { Sha256 } = require('@aws-crypto/sha256-js');
const { HttpRequest } = require('@smithy/protocol-http');
const signer = new SignatureV4({
service: 's3',
region: 'us-east-1',
credentials: {
accessKeyId: 'AKID',
secretAccessKey: 'SECRET'
},
sha256: Sha256
});
const request = new HttpRequest({
method: 'GET',
hostname: 'examplebucket.s3.amazonaws.com',
path: '/exampleobject'
});
signer.sign(request).then(signedRequest => {
console.log(signedRequest);
});
Presigning URLs
This feature allows you to generate presigned URLs for AWS services, which can be used to grant temporary access to resources. The code sample demonstrates how to presign a URL for an S3 object with a 1-hour expiration.
const { SignatureV4 } = require('@smithy/signature-v4');
const { Sha256 } = require('@aws-crypto/sha256-js');
const { HttpRequest } = require('@smithy/protocol-http');
const { formatUrl } = require('@smithy/util-format-url');
const signer = new SignatureV4({
service: 's3',
region: 'us-east-1',
credentials: {
accessKeyId: 'AKID',
secretAccessKey: 'SECRET'
},
sha256: Sha256
});
const request = new HttpRequest({
method: 'GET',
hostname: 'examplebucket.s3.amazonaws.com',
path: '/exampleobject'
});
signer.presign(request, { expiresIn: 3600 }).then(presignedUrl => {
console.log(formatUrl(presignedUrl));
});
The aws-sdk package is the official AWS SDK for JavaScript, which includes a wide range of functionalities for interacting with AWS services, including request signing. It provides a higher-level abstraction compared to @smithy/signature-v4, making it easier to use for common tasks but less flexible for custom signing needs.
The aws4 package is a lightweight library for signing AWS requests with AWS Signature Version 4. It is similar to @smithy/signature-v4 in that it focuses specifically on request signing, but it is less integrated with the broader AWS SDK ecosystem.
Readme
This package contains an implementation of the AWS Signature Version 4 authentication scheme.
It is internal to Smithy-TypeScript generated clients, and not generally intended for standalone usage outside this context.
For custom usage, inspect the interface of the SignatureV4 class.
FAQs
A standalone implementation of the AWS Signature V4 request signing algorithm
The npm package @smithy/signature-v4 receives a total of 13,629,600 weekly downloads. As such, @smithy/signature-v4 popularity was classified as popular.
We found that @smithy/signature-v4 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Employee Spotlight
Philipp Burckhardt recounts his journey from childhood computer fascinations, to building an e-learning platform at Carnegie Mellon University, and on to his current role at Socket.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.